home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 July / EnigmA AMIGA RUN 20 (1997)(G.R. Edizioni)(IT)[!][issue 1997-07 & 08][EAR-CD IV].iso / earcd / biz / patch / xdve270i.lha / x-dve.lha / Utils / XFAPlay.DOC < prev    next >
Text File  |  1996-07-22  |  8KB  |  197 lines
  1. ******************************************************************************
  2. *                                                                            *
  3. *                  eXtra Fast Animation Shell/WB/ARexx Player                *
  4. *                                                                            *
  5. *                © ClassX Development 1996, all rights reserved              *
  6. *                                                                            *
  7. *            ClassX   Via Francesca 463  I - 56030 Montecalvoli (PI)         *
  8. *                       Tel+Fax  +39 587 749206                              *
  9. *                                                                            *
  10. ******************************************************************************
  11.  
  12. ** Introduction
  13. XFAPlay has been developed to give users an efficient XFA player.
  14. It is freely distributable for NON-COMMERCIAL purposes and it is subject
  15. to the ShareWare rules.
  16.  
  17. ** Technical characteristics
  18. XFAPlay allows to load and play XFA animations from memory or disk and can
  19. be used under three different operating environments: Shell (CLI), Workbench
  20. or ARexx.
  21. To keep user interface as consistent as possible, the available commands
  22. have the same mnemonical syntax in all of the three environments.
  23. XFAPlay uses xfa.library (© ClassX 1995) and it is small (less than 60Kb),
  24. leaving room for animations.
  25. XFAPlay is able to play animations with an "AutoPause" facility.
  26. When playing animations with autopause on, XFAPlay will automatically freeze
  27. the animation in correspondence of frames without moving objects, waiting
  28. for a mouseclick to continue.
  29.  
  30. ******************************************************************************
  31. **                         Using XFAPlay from SHELL                         **
  32. ******************************************************************************
  33.  It is supposed a minimal knowledge of the operational modality of AmigaDos
  34.  for the best use of XFAPlay.
  35. ******************************************************************************
  36.  
  37. If launched through a SHELL, XFAPlay behaves like a normal AmigaDos command.
  38. Starting it without arguments, it shows its version and usage prototype.
  39.  
  40. ex:
  41. > XFAPlay
  42. XFAPlay v1.01 (c) ClassX 24-5-1996
  43. Usage: XFAPlay <filename> [Loop|AutoPause|NoWait|WBModeID]
  44.  
  45.  
  46. where:
  47.  <filename>  is the full pathname of the animation to be played (needed).
  48.  [Loop]      switch: enables the infinite-loop mode.
  49.  [AutoPause] switch: enables the automatic pauses facility.
  50.  [NoWait]    switch: disables the wait-for-mouse at the start/end of the
  51.              animation.
  52.  [WbModeId]  switch: forces XFAPlay to use a screen compatible with workbench
  53.              (useful to play XFA animations on Amigas without a PAL monitor).
  54.  
  55.  
  56. Each modifier (keyword between square brackets) is optional and enables
  57. the related function only if present in XFAPlay call.
  58. If no modifier is specified, the default play condition will be:
  59. No Loop, No AutoPause, Wait, No WbModeID.
  60. Modifiers are not case sensitive.
  61.  
  62. usage example:
  63. > XFAPlay dh1:x-dve/xfa/prova.xfa LOOP WBMODEID
  64.  
  65. Will execute "prova.xfa" animation in LOOP mode, on a WB-compatible screen.
  66.  
  67. Wanting to create a simple script that loads and executes a set of animations,
  68. it is sufficient to build a small file (with ED) that contains a list of
  69. XFAPlay commands.
  70.  
  71. For example:
  72.  
  73. (start ED from a shell)
  74.  
  75. >ED show
  76.  
  77. (type the commands you need to show animations)
  78.  
  79. XFAPlay dh1:x-dve/xfa/intro.xfa NOWAIT
  80. XFAPlay dh1:x-dve/xfa/headtitles.xfa  NOWAIT
  81. XFAPlay dh1:x-dve/xfa/marriage.xfa NOWAIT
  82. XFAPlay dh1:x-dve/xfa/endtitles.xfa NOWAIT
  83.  
  84. (press ESC, x, to save the script)
  85. (now, execute the script)
  86.  
  87. > Execute show
  88.  
  89. Here we are: XFAPlay is showing your animations.
  90.  
  91.  
  92. ******************************************************************************
  93. **                        Using XFAPlay from Workbench                      **
  94. ******************************************************************************
  95.  
  96. If XFAPlay is started from Workbench (doubleclicking on its icon), it shows
  97. its intuition interface on the screen.
  98. As you can see, there are a few buttons, meaning it will be not so much
  99. difficult to manage.
  100. The first thing to do to load and play an animation is to select its name
  101. with the "Src" (source) button.
  102. Once the animation is selected, its name will appear in the "Src" field, but
  103. nothing will be loaded in memory (it is possible to play it only from disk).
  104. XFAPlay is clever enough to enable and disable its buttons if there is or
  105. not an animation in memory, reducing the possibility to make mistakes.
  106. The "Play Disk" function has been introduced to easily preview animations
  107. without having to load them in memory.
  108. Playing animations from disk, is very cheap in terms of memory consumption
  109. and allows to see a long animation even on Amigas without memory to load it
  110. in full.
  111. Besides, playing from disk is accurate and smooth enough to allow an effective
  112. use of this feature (but sometimes 32BitI and 16BitI animation could "jump",
  113. expecially on slow machines with slow disks). 
  114. After loading the animation in memory with "Load XFA", "Play Mem" button
  115. becomes active and it is sufficient to click it to see the animation.
  116. Even the "?" button is now active, allowing to get some informations on the
  117. animation currently in memory.
  118. CheckBoxes in XFAPlay window (if enabled) act as follows:
  119.  
  120.  [Loop]      switch: enables the infinite-loop mode.
  121.  [AutoPause] switch: enables the automatic pauses facility.
  122.  [NoWait]    switch: disables the wait-for-mouse at the start/end of the
  123.              animation.
  124.  [WbModeId]  switch: forces XFAPlay to use a screen compatible with workbench
  125.              (useful to play XFA animations on Amigas without a PAL monitor).
  126.  [Slow]      switch: forces XFAPlay execute the animation at half speed
  127.              (only playing the animation from memory).
  128.  
  129. They are used completely when playing the animation from memory; only WBModeID
  130. modifyer is managed by disk play facility.
  131. The "Free" button frees the memory occupied by the animation, making possible
  132. to play it again from disk.
  133. We remember that it is possible to stop the play from disk keeping both
  134. mousebuttons pressed until it stops.
  135.  
  136. ******************************************************************************
  137. **                        Using XFAPlay from ARexx                          **
  138. ******************************************************************************
  139. As already mentioned, XFAPlay has a ARexx interface that allows to control
  140. and play XFA animations from other ARexx-compatible programs.
  141.  
  142. The ARexx port name of XFAPlay is "XFAPlay" (case sensitive) and supports
  143. the following commands (must be UPPERCASE):
  144.  
  145. XFA_REQSRC <s>         ;Opens a FileRequester and presets is to the <s> path.
  146. XFA_SOURCE <s>         ;Sets the "Src" field of XFAPlay with the <s> path.
  147. XFA_LOAD               ;Loads the "Src" animation in memory.
  148. XFA_FREE               ;Frees the memory occupied by the animation.
  149. XFA_PLAYMEM            ;Plays the animation in memory (if present).
  150. XFA_PLAYDISK           ;Plays the "Src" animation from disk (if present).
  151. XFA_LOOP      <ON|OFF> ;Sets/Resets the infinite-loop playmode.
  152. XFA_AUTOPAUSE <ON|OFF> ;Sets/Resets the autopause playmode.
  153. XFA_NOWAIT    <ON|OFF> ;Sets/Resets the nowait playmode.
  154. XFA_WBMODEID  <ON|OFF> ;Sets/Resets the wbmodeid playmode.
  155. XFA_SLOW      <ON|OFF> ;Sets/Resets the slow playmode.
  156.  
  157. XFAPlay window gadgets will reflect the current status of the settings and
  158. the commands sent by any ARexx script.
  159.  
  160. Eample of an ARexx script:
  161.  
  162. /* play from memory */
  163.  
  164.     options results
  165.     address 'XFAPlay'
  166.  
  167.     XFA_SOURCE "DK3:XFA/ClassX.XFA"
  168.    XFA_LOAD
  169.     XFA_AUTOPAUSE OFF
  170.     XFA_LOOP OFF
  171.     XFA_PLAYMEM
  172.     XFA_FREE
  173.    exit
  174.  
  175. /* end script */
  176.  
  177. Or:
  178.  
  179. /* play from disk */
  180.  
  181.     options results
  182.     address 'XFAPlay'
  183.  
  184.     XFA_SOURCE "DK3:XFA/ClassX.XFA"
  185.     XFA_PLAYDISK
  186.    exit
  187.  
  188. /* end script */
  189.  
  190. Remember that XFAPlay ARexx interface can only work if:
  191. - RexxMast ARexx server is up and running before starting the application.
  192.   A requester will warn you if RexxMast is not present in memory. 
  193. - XFAPlay has been started from WorkBench.
  194.  
  195.  
  196. ******************************************************************************
  197.